home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / util / misc / man25.lha / Man2.5 / DOCS / English / Man.DOC < prev    next >
Encoding:
Text File  |  1993-11-17  |  4.0 KB  |  116 lines
  1. Document Man
  2.  
  3. Man v2.5 - © 1993 by Markus Hillenbrand
  4. ---------------------------------------
  5.  
  6. Man is a program to view texts and docs from Shell or WB.
  7.  
  8.  
  9. 1. Requirements
  10. ~~~~~~~~~~~~~~~
  11.  
  12. You need:            - asl.library         v37
  13.                      - intuition.library   v37
  14.                      - gadtools.library    v37
  15.                      - graphics.library    v37
  16.                      - dos.library         v37
  17.              - icon.library        v37 (ManCom only)
  18.              - commodities.library v37 (ManCom only)
  19.  
  20. Supported:           - locale.library      v38
  21.                      - reqtools.library    v38 (busy-pointer)
  22.  
  23. Recommended:         - a harddisk to use help-texts efficiently
  24.                      - "MultiView" from OS3.0 to read .guide files
  25.                      - "Amigaguide" from OS2.0, if you don´t have 3.0
  26.  
  27.  
  28. 2. Configuration
  29. ~~~~~~~~~~~~~~~~
  30.  
  31. To configure the program, type "man -c" or "man -config" in your shell.
  32. A window opens where you can enter several specifications.
  33.  
  34. The gadget "Path for texts": here you enter the path which the program
  35. will search to get the texts. You can also enter an assign, so that the
  36. program will search several directories. The best of all is to create a
  37. directory on a harddisk-partition where you locate all .DOC and .guide
  38. files.
  39.  
  40. The gadget "program": here you enter the program to use for viewing and
  41. reading texts (maybe your favourite text-reader).
  42.  
  43. The four gadgets on the right side represent the suffixes you can select.
  44. In last of them you can enter your own suffix (if you insert ".guide" 
  45. you can prevent the program from calling "Multiview" or "AmigaGuide".
  46.  
  47.  
  48. 3. Shell-usage
  49. ~~~~~~~~~~~~~~
  50.  
  51. To read a text from shell, you have to add its name in the command line.
  52. Here you must not enter the suffix! "Man lha" for example searches for
  53. lha.doc, lha.dok, lha.man, and ... in the preferred directory/assign.
  54. This text will then be shown with your preferred text-reader.
  55. If you enter "man -l" you´ll get a list of all texts located in your
  56. directory/assign.
  57. If you call man without any parameter, an asl.requester will open and
  58. ask you for the text.
  59.  
  60.  
  61. 4. Localisation under WB2.1+
  62. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  63.  
  64. Since Workbench 2.1 the program can be localized, i.e. it can be translated
  65. into several languages. Therefor I added the C source of the catalog. In the
  66. original only the german and english version are supported.
  67. The C source kann easily be changed, and with a suitable program (i.e. 
  68. MakeCat - © Paladin-Software etc.) you can rebuild the catalog.
  69. If you have created a new catalog it would be nice if you send me the new
  70. C source via e-mail. Perhaps I can add the new language in a newer version
  71. of man.
  72.  
  73.  
  74. 5. ManCom - the Man commodity
  75. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  76.  
  77. ManCom v1.1 is a commodity, that waits for a hotkey (CTRL HELP) and opens a
  78. requester, which asks for the text to show.
  79. Its quite the same as calling man without any parameter from the shell, with
  80. one exception: it resides in memory until it is unloaded.
  81. With "Exchange" you can open the configuration window (the same as "man -c").
  82.  
  83. The program reads the tooltypes of the program icon. These can be:
  84.  
  85.   HOTKEY=...    and   CX_PRIORITY=...
  86.  
  87. Here you can enter values suitable for commodities.
  88.  
  89.  
  90. 6. Copyright
  91. ~~~~~~~~~~~~
  92.  
  93. `Man' is Copyright (C) 1993 Markus Hillenbrand and it's freely distributable
  94. as long as all of its files are included in their original form without
  95. additions, deletions, or modifications of any kind, and only a nominal fee
  96. is charged for its distribution. This software is provided *AS IS* without 
  97. warranty of any kind, either expressed or implied. By using `Man', you agree
  98. to accept the entire risk as to the quality and performance of the program.
  99.  
  100. Of course, it was tested rather extensively before it was released...
  101.  
  102.  
  103. 7. Address of the author
  104. ~~~~~~~~~~~~~~~~~~~~~~~~
  105.  
  106. Here´s my address (bug-report, suggestions or something like that):
  107.  
  108.            Markus Hillenbrand
  109.            Weserstrasse 9
  110.            36124 Eichenzell-Loeschenrod 
  111.  
  112.            GERMANY
  113.  
  114.  
  115. or e-mail: m_hillen@informatik.uni-kl.de
  116.